Retrieve data for a ShipmentNote

SecurityAuthToken
Request
path Parameters
shipmentId
required
string <uuid>

The id of the shipment

shipmentNoteId
required
string <uuid>
Responses
200

Data for a Shipment Note

Response Schema: application/json
company
string or null <uuid>
created_at
string or null <date-time>
creator_avatar
string or null
creator_full_name
string or null
creator_id
string or null <uuid>
id
string or null <uuid>
is_pinned
boolean
message
string or null
shipment
string or null <uuid>
updated_at
string or null <date-time>
default

Default error response

get/shipments/{shipmentId}/notes/{shipmentNoteId}/
Request samples
Response samples
application/json
{
  • "company": "87340f10-f684-4b06-8427-5981380bd9a9",
  • "created_at": "2019-08-24T14:15:22Z",
  • "creator_avatar": "string",
  • "creator_full_name": "string",
  • "creator_id": "9cceffdd-8381-4074-8256-eafae24ebee6",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_pinned": true,
  • "message": "string",
  • "shipment": "040451d7-03ba-4b1e-94f7-5cacc36efb36",
  • "updated_at": "2019-08-24T14:15:22Z"
}
Copyright © Shipwell 2024. All right reserved.